Range(cloud dedicated)
Function
This API is used to get parameter range for Record > Playback Page page.
Request Message
None.
Sample:
POST API/Playback/PlaybackPage/Range HTTP/1.1
{
"version": "1.0"
}
Response Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| Normal | Json object | Show as followTable2 | |
| Picture | Json object | Show as followTable2 | |
| car_type | "unknown" "Bus" "Car" "SUV" "Truck" "Van" | string array | Car type, c1.1.1 ipc new add |
| car_color | "unknown" "black" "blue" "brown" "golden" "gray" "green" "orange" "red" "white" "yellow" | string array | Car color, c1.1.1 ipc new add |
| car_brand | "AC Chnitzer" "Acura" "Alfa Romeo" "Aston Martin" "Audi" "Baihc" "Baojun" "BAW" "Beiqihuansu" "Beiqiweiwang" "Bentley" "Benz" "Besturn" "BMW" "Brabus" "Buck" "BYD" "Cadillac" "Changan" "Changan Business" "Cheetah" "Chevy" "Chrey" "Chrysler" "Citroen" "Dacia" "Dodge" "Dongfengfengshen" "Dongfengfengxing" "Dongfengxiaokang" "Dongnan" "DS" "Ferrari" "FIAT" "Ford" "Fudi" "Futian" "GAC" "Geely" "GreatWall" "GMC" "Guangqichuanqi" "Hafei" "Haige" "Haima" "Haima(Zhengzhou)" "Haval" "Honda" "Huanghai" "Huatai" "Hyundai" "Infiniti" "Jaguar" "Jeep" "Jianghuai" "Jiangling" "Jinbei" "Karry" "KIA" "Koenigsegg" "Lamborghini" "Lancia" "LAND-ROVER" "Lexus" "Lifan" "Lincoln" "Lotus" "Lufeng" "Luxgen" "Maserati" "MAZDA" "McLaren" "MG" "MINI" "Mitsubishi" "Mustang" "Nissan" "Opel" "Pagani" "Peugeot" "Porsche" "Renault" "Roewe" "Rolls-Royce" "Ruiqi" "SAAB" "Scion" "Seat" "Shangqidatong" "Shuanghuan" "Shuanglong" "Skoda" "smart" "Subaru" "Suzuki" "TESLA" "Toyota" "Unknown" "Vauxhall" "Venucia" "Volkswagen" "Volvo" "Wealeak" "Wuling" "Yiqi" "Zhonghua" "Zoyte" "Zxauto" | string array | Car brand c1.1.1 ipc new add |
| type_enum_arr | "nor", "md", "io", "od", "manual", "netbreak", "pid", "lcd", "intrusion", "enter", "exit", "sod", "pdvd", "fd", "cc", "attr", "cd", qd", "lpd", "pedestrian", "vehicle", "nonvehicle", "rsd", "multitype", "animal" | Json object | |
| person_age | "AgeOver60", "Age45-60", "Age30-45", "Age18-30", "AgeLess18" | Json string | |
| person_bag | "HandBag", "ShoulderBag", "Backpack" | Json string | |
| person_gender | "Female" | Json string | |
| person_glasses | "Yes" | Json string | |
| person_hat | "Yes" | Json string | |
| person_longcoat | "Yes" | Json string | |
| person_lower_color | "LowerBlack", "LowerGrey", "LowerBlue", "LowerWhite", "LowerBrown", "LowerRed", "LowerPink", "LowerGreen", "LowerOrange", "LowerYellow", "LowerPurple" | Json string | |
| person_lower_type | "Trousers", "Shorts", "Skirt&Dress" | Json string | |
| person_sleeve_length | "ShortSleeve", "LongSleeve" | Json string | |
| person_toward | "Front", "Side", "Back" | Json string | |
| person_upper_color | "UpperBlack", "UpperGrey", "UpperBlue", "UpperWhite", "UpperBrown", "UpperRed", "UpperPink", "UpperGreen", "UpperOrange", "UpperYellow", "UpperPurple" | Json string |
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| display_mode | "Treelike", "Checkbox" | int | UI display type |
| default_sort_of_results | int | Search information in default or reverse order | |
| items | int | Show as followTable3 | |
| similarity_face | int | Control the range and default value of the IE playback Face Detection similarity input box | |
| similarity_customer | int | Control the Fault-tolerant input field and the default value of the IE playback License Plate | |
| similarity_license | int | The range and default value of the similarity input box controlling the IE playback of Repeat customer | |
| recordColorArr | Array | Search video color alerts。Show as followTable7.Note: cloud dedicated | |
| record_type_arr | Array | Show as followTable8.Note: cloud dedicated | |
| type_filter_arr | Array | Intelligent human model color display。Show as followTable9.Note: cloud dedicated | |
| support_person_attr | int | Does the device support pedestrian attributes |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| record_type | Json object | layback type Show as followTable4 | |
| stream_mode | "Mainstream", "Substream" | string | Primary substream type (Normal only has this field) |
| pos_search_detail | Json object | pos filter search See table11(NVR dedicated) |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| normal | bool | common | |
| manual | bool | manual operation | |
| alarm | Json object | Alarm Show as followTable5 (IPC only) | |
| smart | Json object | Intelligence Show as followTable6 (for IPC) | |
| Human | bool | AI Humanoid (NVR only) | |
| Vehicle | bool | AI models (NVR only) | |
| IO | bool | Io Alarm Video Type (NVR special) | |
| motion | bool | Motion Alarm Video Type (NVR only) | |
| PIR | bool | Pir（NVR only） | |
| Sound | bool | Audible alarm (NVR only) | |
| occulusion | bool | Lens Occlusion (NVR only) | |
| Intelligent | bool | Intelligent Analytics (NVR only) | |
| PID | bool | AI Perimeter Intrusion (NVR only) | |
| LCD | bool | AI crossing Detection (NVR only) | |
| faceAttr | bool | Face Properties (NVR only) |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| IO | Json object | IO alarm video type | |
| motion | Json object | Motion Alarm Video Type | |
| PIR | Json object | Pir | |
| Sound | Json object | Audible alarm | |
| Netbreak | Json object | Off-grid recording |
Table 6
| Parameter | Range | Type | Description |
|---|---|---|---|
| PID | bool | ||
| LCD | bool | ||
| SOD | bool | ||
| PD | bool | ||
| FD | bool | ||
| CC | bool | ||
| intrusion | bool | ||
| regionEntrance | bool | ||
| regionExiting | bool |
Table 7
| Parameter | Range | Type | Description |
|---|---|---|---|
| common | int | Video common color reminders | |
| event | int | Video event color reminders | |
| color | String | Search for smart types to display colors |
Table 8
| Parameter | Range | Type | Description |
|---|---|---|---|
| type | "common", "event"", "default", "pedestrian", "vehicle", "nonvehicle", "animal" | String | Intelligent support type |
| color | String | Search for smart types to display colors | |
| children | Array | child node：Show as followTable9 |
Table 9
| Parameter | Range | Type | Description |
|---|---|---|---|
| type | "normal", "md", "io", "netbreak", "pdvd", "lpd", "fd", "intrusion", "enter", "exit", "lcd", "cc", "sod", "rsd", "qd", "cd", "attr", "od", "pedestrian", "vehicle", "nonvehicle", "nonvehicle", "multitype | String | Intelligent support type |
| color | String | Search for smart types to display colors | |
| expand | Array | Whether the child node can be expanded and whether the video type used for web display can be expanded | |
| children | Array | child node：Show as followTable10 |
Table 10
| Parameter | Range | Type | Description |
|---|---|---|---|
| type | "nor", "lcd", "cc", "sod", "rsd", "qd", "cd", "attr", "od", "pedestrian", "vehicle", "nonvehicle", "pos"(NVR dedicated), | String | Intelligent support type |
| color | String | Search for smart types to display colors |
Table 11
| Parameter | Range | Type | Description |
|---|---|---|---|
| keyword | object | pos search keyword, See table 12 | |
| casesensitive | bool | Is it case sensitive | |
| condition | "Anyone"，"Allof" | string | Match all or any one |
Table 12
| Parameter | Range | Type | Description |
|---|---|---|---|
| keyword_1 | maxLength:31 | string | Keyword 1 |
| keyword_2 | maxLength:31 | string | Keyword 2 |
| keyword_3 | maxLength:31 | string | Keyword 3 |
Tips
The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.
Sample
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"Picture": {
"type": "object",
"items": {"record_type": {
"type": "object",
"items": {
"normal": {"type": "bool"},
"event": {
"type": "object",
"items": {
"IO": {"type": "bool"},
"PIR": {"type": "bool"},
"motion": {"type": "bool"}
}
}
}
}},
"display_mode": "Treelike"
},
"Normal": {
"type": "object",
"items": {"record_type": {
"type": "object",
"items": {
"normal": {"type": "bool"},
"event": {
"type": "object",
"items": {
"IO": {"type": "bool"},
"PIR": {"type": "bool"},
"Netbreak": {"type": "bool"},
"motion": {"type": "bool"},
"occulusion": {"type": "bool"}
}
},
"ai": {
"type": "object",
"items": {
"lcd": {"type": "bool"},
"sod": {"type": "bool"},
"pd&vd": {"type": "bool"},
"fd": {"type": "bool"},
"cc": {"type": "bool"},
"cd": {"type": "bool"},
"qd": {"type": "bool"},
"lpd": {"type": "bool"},
"intrusion": {"type": "bool"},
"regionEntrance": {"type": "bool"},
"regionExiting": {"type": "bool"},
"faceAttr": {"type": "bool"},
"rsd": {"type": "bool"},
"Pedestrian": {"type": "bool"},
"MotorVehicle": {"type": "bool"},
"Non-motorized Vehicle": {"type": "bool"}
}
}
}
}},
"display_mode": "Treelike",
"recordColorArr": [
{
"common": 0,
"color": "#48C840"
},
{
"event": 0,
"color": "#30A0F8"
}
],
"record_type_arr": [
{
"type": "common",
"color": "#48C840",
"children": [
{
"type": "normal",
"color": "#48C840",
"expand": false,
"children": [{
"type": "nor",
"color": "#48C840"
}]
},
{
"type": "md",
"color": "#48C840"
},
{
"type": "io",
"color": "#48C840"
},
{
"type": "netbreak",
"color": "#48C840"
}
]
},
{
"type": "event",
"color": "#30A0F8",
"children": [
{
"type": "pdvd",
"color": "#30A0F8"
},
{
"type": "lpd",
"color": "#30A0F8"
},
{
"type": "fd",
"color": "#30A0F8"
},
{
"type": "intrusion",
"color": "#30A0F8"
},
{
"type": "enter",
"color": "#30A0F8"
},
{
"type": "exit",
"color": "#30A0F8"
},
{
"type": "lcd",
"color": "#30A0F8"
},
{
"type": "cc",
"color": "#30A0F8"
},
{
"type": "sod",
"color": "#30A0F8"
},
{
"type": "rsd",
"color": "#30A0F8"
},
{
"type": "qd",
"color": "#30A0F8"
},
{
"type": "cd",
"color": "#30A0F8"
},
{
"type": "attr",
"color": "#30A0F8"
},
{
"type": "od",
"color": "#30A0F8"
},
{
"type": "pedestrian",
"color": "#30A0F8"
},
{
"type": "vehicle",
"color": "#30A0F8"
},
{
"type": "nonvehicle",
"color": "#30A0F8"
},
{
"type": "multitype",
"color": "#30A0F8"
}
]
}
],
"type_filter_arr": [
{
"type": ["default"],
"color": "#48C840"
},
{
"type": ["pedestrian"],
"color": "#30A0F8"
},
{
"type": [
"vehicle",
"nonvehicle"
],
"color": "#30A0F8"
},
{
"type": ["animal"],
"color": "#30A0F8"
},
]
},
"car_color": {
"type": "string",
"items": [
"black",
"blue",
"brown",
"golden",
"gray",
"green",
"orange",
"red",
"unknown",
"white",
"yellow"
]
},
"car_type": {
"type": "string",
"items": [
"Bus",
"Car",
"SUV",
"Truck",
"unknown",
"Van"
]
},
"car_brand": {
"type": "string",
"items": [
"Unknown",
"DS",
"Dacia",
"GMC",
"Jeep",
"MG",
"MINI",
"Scion",
"TESLA",
"smart",
"Yiqi",
"Mitsubishi",
"Shangqidatong",
"Dongnan",
"Dongfengxiaokang",
"Dongfengfengshen",
"Dongfengfengxing",
"Zxauto",
"Zhonghua",
"Toyota",
"Wuling",
"AC Chnitzer",
"Zoyte",
"Porsche",
"Chrysler",
"Lamborghini",
"Cadillac",
"Buck",
"Lifan",
"Rolls-Royce",
"BAW",
"Baihc",
"Beiqiweiwang",
"Beiqihuansu",
"Huatai",
"Shuanghuan",
"Shuanglong",
"Geely",
"Venucia",
"Haval",
"Hafei",
"Volkswagen",
"Chrey",
"Besturn",
"Benz",
"Audi",
"Wealeak",
"BMW",
"Baojun",
"Bentley",
"Brabus",
"Pagani",
"Guangqichuanqi",
"GAC",
"Karry",
"Jaguar",
"Subaru",
"Skoda",
"Nissan",
"Honda",
"Lincoln",
"Peugeot",
"Opel",
"BYD",
"Jianghuai",
"Jiangling",
"Vauxhall",
"Volvo",
"Ferrari",
"Haige",
"Haima",
"Haima(Zhengzhou)",
"Cheetah",
"Maserati",
"Hyundai",
"Ruiqi",
"Ford",
"Futian",
"Fudi",
"Koenigsegg",
"Luxgen",
"SAAB",
"Infiniti",
"Roewe",
"Lotus",
"FIAT",
"Lancia",
"Seat",
"Acura",
"KIA",
"LAND-ROVER",
"McLaren",
"Dodge",
"Mustang",
"Jinbei",
"Suzuki",
"GreatWall",
"Changan Business",
"Changan",
"Alfa Romeo",
"Aston Martin",
"Lufeng",
"Chevy",
"Citroen",
"Lexus",
"Renault",
"MAZDA",
"Huanghai"
]
},
"person_upper_color": {
"type": "string",
"items": [
"UpperBlack",
"UpperGrey",
"UpperBlue",
"UpperWhite",
"UpperBrown",
"UpperRed",
"UpperPink",
"UpperGreen",
"UpperOrange",
"UpperYellow",
"UpperPurple"
]
},
"person_lower_color": {
"type": "string",
"items": [
"LowerBlack",
"LowerGrey",
"LowerBlue",
"LowerWhite",
"LowerBrown",
"LowerRed",
"LowerPink",
"LowerGreen",
"LowerOrange",
"LowerYellow",
"LowerPurple"
]
},
"person_gender": {
"type": "string",
"items": [
"Female"
]
},
"person_age": {
"type": "string",
"items": [
"AgeOver60",
"Age45-60",
"Age30-45",
"Age18-30",
"AgeLess18"
]
},
"person_hat": {
"type": "string",
"items": [
"Yes"
]
},
"person_glasses": {
"type": "string",
"items": [
"Yes"
]
},
"person_sleeve_length": {
"type": "string",
"items": [
"ShortSleeve",
"LongSleeve"
]
},
"person_longcoat": {
"type": "string",
"items": [
"Yes"
]
},
"person_lower_type": {
"type": "string",
"items": [
"Trousers",
"Shorts",
"Skirt&Dress"
]
},
"person_bag": {
"type": "string",
"items": [
"HandBag",
"ShoulderBag",
"Backpack"
]
},
"person_toward": {
"type": "string",
"items": [
"Front",
"Side",
"Back"
]
},
"type_enum_arr": [
"nor",
"md",
"io",
"od",
"manual",
"netbreak",
"pid",
"lcd",
"intrusion",
"enter",
"exit",
"sod",
"pdvd",
"fd",
"cc",
"attr",
"cd",
"qd",
"lpd",
"pedestrian",
"vehicle",
"nonvehicle",
"rsd",
"multitype",
"animal"
]
}
}
Error Code
See Response Messages Body and Common error_code for more information.